Ficha técnica

Seguridad

📘 BTG Id

El Authorization Server de BTG Empresas se llama BTG Id. Utilizando el BTG Id, una aplicación asociada puede obtener consentimiento y autorización para ejecutar operaciones en las APIs del BTG en nombre del cliente. Para saber más, acceda a la documentación del BTG Id

Alcances necesarios

El token para consumir la API de leads de crédito debe ser generado utilizando el Client credentials.

Es necesario informar el siguiente alcance al realizar el flujo:

Alcance	Descripción
brn:btg:empresas:kgiro:workflow	Acceso al workflow de leads de crédito

Eventos de Webhook

La API de Leads de crédito tiene sus webhooks divididos en dos familias de eventos: Eventos de motor de crédito y evento de cambio de estado.

Los payloads disponibles a continuación representan el contenido del campo data.

Eventos de motor de crédito

Evento	Descripción
credit-kgiro.kgiro-analyzed	Respuesta del análisis de capital de trabajo
credit-kgiro.overdraft-analyzed	Respuesta del análisis de límite de cuenta
credit-kgiro.card-analyzed	Respuesta del análisis de tarjeta de crédito
credit-kgiro.collection-receivable-analyzed	Respuesta del análisis de descuento de facturas
credit-kgiro.card-receivable-analyzed	Respuesta del análisis de anticipación de cuentas por cobrar de tarjeta

Payload

{
        "externalId": "593211b78a1-60d-4155-bb812322133123",
        "status": "Released",
        "approvedAmount": 100000.00,
        "expirationDate": "2025-12-31",
        "taxId": "CNPJ",
        "indexCode": "PRE", // CDI, PRE, NIPCA
        "fundingType": "BTG", //BTG, BNDES
        "product": "KGIRO",
        "quotes": [
            {
                "rate": 0.5,
                "minTerm": 12,
                "maxTerm": 60,
                "minGracePeriod": 3,
                "maxGracePeriod": 12,
                "rateFrequency": "MENSAL"
            }
        ],
        "guarantors": [
            {
                "type": "SIMPLES",
                "guarantorIdentification": "CPF"
            },
            {
                "type": "COMPLETO",
                "guarantorIdentification": "CPF"
            }
        ]
}

Campo	Descripción
externalId	Identificador de la propuesta, informado por el sistema externo al crear la propuesta
status	Estado de la propuesta - Released (Aprobado), NotApproved (No aprobado)
approvedAmount	Monto aprobado en reales
expirationDate	Fecha de expiración de la propuesta
taxId	Documento del cliente
indexCode	Indexador de la tasa aprobada en la propuesta - PRE, CDI, NIPCA
product	Producto analizado - KGIRO, LIMITE_MAIS, CARTAO_DE_CREDITO, ANTECIPACAO_DE_RECEBIVEIS_CARTAO, ANTECIPACAO_DE_RECEBIVEIS_BOLETOS
quotes	Condiciones financieras aprobadas (solo cuando el product tiene los valores ANTECIPACAO_DE_RECEBIVEIS_BOLETOS o KGIRO)
quotes.rate	Tasa aprobada
quotes.minTerm	Mínimo de cuotas
quotes.maxTerm	Máximo de cuotas
quotes.minGracePeriod	Mínimo de período de gracia
quotes.maxGracePeriod	Máximo de período de gracia
quotes.rateFrequency	Frecuencia de la tasa - MENSAL, ANUAL
guarantors	Garantes de la operación
guarantors.type	Tipo de garante - SIMPLES, COMPLETO
guarantors.guarantorIdentification	Documento del garante

Eventos de cambio de estado

Evento	Descripción
credit-kgiro.changed-status	Cambio de estado

Payload

{
        "taxId": "CNPJ",
        "status": "CreditAnalysisDisapproved",
        "originId": "4d4df455-bfc8-4235-b7b0-c3146c24647b",
        "occurrenceDate": "2025-01-23T17:26:00.699801",
}

El campo status puede tener los siguientes valores:

Estados posibles	Descripción
CreditPendingSubmit	Pendiente de envío de la solicitud de crédito
CreditPreAnalysized	Solicitud aprobada en el pre-análisis de crédito
CreditAnalysis	Solicitud bajo análisis de crédito
CreditPendingScr	Pendiente de confirmación del Optin SCR enviado por e-mail al cliente
CreditPendingECnpj	Pendiente de envío del certificado A1 (e-CNPJ) solicitado por e-mail al cliente
CreditExpired	La solicitud expiró en la etapa de análisis de crédito
CreditDisapproved	La solicitud fue rechazada en la etapa de análisis de crédito
CreditDataAdjustment	La solicitud tiene pendencias a resolver en la etapa de crédito
CreditApproved	La solicitud fue aprobada en el análisis de crédito
AccountCreationWaitingForOnboarding	Esperando el inicio del proceso de onboarding del cliente en la plataforma
AccountCreationPendingSubmit	Pendiente de envío de la información del cliente para apertura de cuenta en la plataforma
AccountCreationAnalysis	Información del cliente para apertura de cuenta bajo análisis
AccountCreationWaitingSignatures	Esperando las firmas del cliente para realizar la apertura de cuenta
AccountCreationDisapproved	Apertura de cuenta rechazada
AccountCreationDataAdjustment	Pendiente de ajustes en la información de apertura de cuenta del cliente
ContractingWaitingOperation	Esperando la contratación de crédito por el cliente
ContractingGuarantorsOnboarding	Esperando el onboarding de los garantes de la contratación del crédito
ContractingWaitingSignatures	Pendiente de firmas del cliente para la contratación del crédito
ContractingWaitingDisbursement	Esperando el desembolso del crédito en la cuenta del cliente
ContractingOperationDisbursed	Desembolso del crédito realizado
ContractingContracted	Crédito contratado por la plataforma